Search for Active Directory users

{ searchAdUsers }

Find users on the Active Directory.

Method

/API3/access/searchAdUsers

  • API Section: /API3/access
  • API Version: 3.0
  • From Release: 2023.10
  • Usage: REST API and Client SDK libraries. REST APIs via POST actions only.
  • Usage by:
    • Enterprise Admin
  • Input Parameters

    Name

    ldapUsersSearch

    Object Type

    Description

    The LDAP search object used to find users in the LDAP directory.

    Output Response

    Successful Result Code

    200

    Response List Type

    Description of Response Type

    LDAP response object with details of each user found in the search.. Note that the response is returned as a list of items of this object type.

    Notes

    Use this function with Active Directory Authentication provider. Build the search object to define the search parameters.

    Examples

    Code Snippets

    Use the Authentication API methods to generate an access 'key' or 'token' for use in code as shown below.

    TypeScript
    Curl
    Java
    C#
    Python
    PHP
    curl -X POST \
    -H "paToken: [[apiKey]]" \
     -H "Accept: application/json,application/json;charset=utf-8,text/plain,text/plain;charset=utf-8" \
     -H "Content-Type: application/json" \
     "http://Your.Server.URL/API3/access/searchAdUsers" \
     -d '{
      "domainNetBios" : "domainNetBios",
      "searchValue" : "searchValue"
    }'
    
    import com.pyramidanalytics.*;
    import com.pyramidanalytics.auth.*;
    import com.pyramidanalytics.model.*;
    import com.pyramidanalytics.api.AccessServiceApi;
    
    import java.util.*;
    import java.time.*;
    
    public class AccessServiceApiExample {
        public static void main(String[] args) {
            ApiClient defaultClient = Configuration.getDefaultApiClient();
            defaultClient.setBasePath("http://Your.Server.URL/");
            
            // Configure API key authorization: paToken
            ApiKeyAuth paToken = (ApiKeyAuth) defaultClient.getAuthentication("paToken");
            paToken.setApiKey("YOUR API KEY");
            // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
            //paToken.setApiKeyPrefix("Token");
    
            // Create an instance of the API class
            AccessServiceApi apiInstance = new AccessServiceApi();
            // Initialize the ldapUsersSearch parameter object for the call
            LdapUsersSearchObject ldapUsersSearch = ; // Create the input object for the operation, type: LdapUsersSearchObject 
    
            try {
                // "array[LdapUserObject]" is only psaudo-code to symbolize list of type and not the actual usage 
                array[LdapUserObject] result = apiInstance.searchAdUsers(ldapUsersSearch);
                System.out.println(result);
            } catch (ApiException e) {
                System.err.println("Exception when calling AccessServiceApi#searchAdUsers");
                e.printStackTrace();
            }
        }
    }
    
    import * as PyramidAnalyticsWebApi from "com.pyramidanalytics";
    
    // Create an instance of the API class
    const api = new PyramidAnalyticsWebApi.AccessServiceApi("http://Your.Server.URL")
    
    // Configure API key authorization: paToken
    api.setApiToken("YOUR API KEY");
    
    const ldapUsersSearch = ; // {LdapUsersSearchObject} 
    
    api.searchAdUsers(ldapUsersSearch).then(function(data) {
      console.log('API called successfully. Returned data: ' + data);
    }, function(error) {
      console.error(error);
    });
    
    
    using System;
    using System.Diagnostics;
    using PyramidAnalytics.Sdk.Api;
    using PyramidAnalytics.Sdk.Client;
    using PyramidAnalytics.Sdk.Model;
    
    public class searchAdUsersExample
    {
        public static void Main()
        {
            Configuration conf = new Configuration();
            conf.BasePath = "http://Your.Server.URL/";
            
            
            // Configure API key authorization: paToken
            conf.ApiKey.Add("paToken", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // conf.ApiKeyPrefix.Add("paToken", "Bearer");
    
            GlobalConfiguration.Instance = conf;
            
            // Create an instance of the API class
            var apiInstance = new AccessServiceApi();
            // Initialize the ldapUsersSearch parameter object for the call
            var ldapUsersSearch = new LdapUsersSearchObject(); // LdapUsersSearchObject | 
    
            try {
                // Find users on the Active Directory.
                // "array[LdapUserObject]" is only psaudo-code to symbolize array of type and not the actual usage 
                array[LdapUserObject] result = apiInstance.searchAdUsers(ldapUsersSearch);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AccessServiceApi.searchAdUsers: " + e.Message );
            }
        }
    }
    
    
    import com.pyramidanalytics
    from com.pyramidanalytics import ApiException
    from com.pyramidanalytics import AccessServiceApi
    from pprint import pprint
    
            
    # Configure API key authorization: paToken
    api_config = com.pyramidanalytics.Configuration(host = 'http://Your.Server.URL/', api_key={ paToken:'YOUR_ACCESS_TOKEN' })
    
    with com.pyramidanalytics.ApiClient(api_config) as api_client:
        # Create an instance of the API class
        api_instance = AccessServiceApi(api_client)
        # Initialize the ldapUsersSearch parameter object for the call
        ldapUsersSearch =  # LdapUsersSearchObject | 
    
        try:
            # Find users on the Active Directory.
            api_response = api_instance.search_ad_users(ldapUsersSearch)
            pprint(api_response)
        except ApiException as e:
            print("Exception when calling AccessServiceApi->searchAdUsers: %s\n" % e)
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    OpenAPITools\Client\Configuration::getDefaultConfiguration()->setHost('http://Your.Server.URL');
    
    // Configure API key authorization: paToken
    OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('paToken', 'YOUR_API_KEY');
    // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    // OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('paToken', 'Bearer');
    
    // Create an instance of the API class
    $api_instance = new OpenAPITools\Client\Api\AccessServiceApi();
    $ldapUsersSearch = ; // LdapUsersSearchObject | 
    
    try {
        $result = $api_instance->searchAdUsers($ldapUsersSearch);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling AccessServiceApi->searchAdUsers: ', $e->getMessage(), PHP_EOL;
    }
    ?>